Skip to content

refactor: move composition api guide to increase discoverability #713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 1, 2021

Conversation

bencodezen
Copy link
Member

Description of Problem

Users had troubles finding the guide in advanced and expected it to be in Reusability and Composition.

Proposed Solution

Additional Information

Copy link
Contributor

@skirtles-code skirtles-code left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of observations, neither of which prevent this from being merged:

  1. There's a certain amount of overlap between the Composition API and Reactivity guides. To me it seems more natural to introduce reactivity prior to composition, though the way the guides are currently written it doesn't seem to rely on either order.
  2. The guide to Render Functions should arguably move the other way. If any core topic counts as an 'Advanced Guide' then surely it's that. However, that move would be a little trickier after this PR because the Composition API guide mentions returning a render function from setup.

Copy link
Member

@sdras sdras left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, thanks for following up with this

@sdras
Copy link
Member

sdras commented Dec 26, 2020

A couple of observations, neither of which prevent this from being merged:

  1. There's a certain amount of overlap between the Composition API and Reactivity guides. To me it seems more natural to introduce reactivity prior to composition, though the way the guides are currently written it doesn't seem to rely on either order.
  2. The guide to Render Functions should arguably move the other way. If any core topic counts as an 'Advanced Guide' then surely it's that. However, that move would be a little trickier after this PR because the Composition API guide mentions returning a render function from setup.

Hey @skirtles-code, this is something we discussed in the vue docs meeting we hold once every two weeks- would you like to attend? If so, please email me: sarah.drasner@gmail.com, we think it would be great to have you there.

We discussed what you were saying, but were also solving for some discoverability issues.

@skirtles-code
Copy link
Contributor

skirtles-code commented Dec 30, 2020

@sdras I'm having trouble sending you an email (problem at my end, boring story). If you're on Vue Land Discord I'm available there as skirtle. Or on the Vue forum.

@sdras
Copy link
Member

sdras commented Jan 1, 2021

@skirtles-code thanks! I'll go find you there.

@sdras sdras merged commit 908a334 into master Jan 1, 2021
@sdras sdras deleted the refactor-placement-of-composition-api-guide branch January 1, 2021 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants